home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / wbgames / wintris_v1.21 / bonusfiles / gmc / gmc.doc < prev    next >
Text File  |  1996-04-07  |  4KB  |  103 lines
  1.  
  2. ------ Documentation for GMC v1.06 - Gothmog's MemClock
  3.        by Gothmog / Spicelab
  4.  
  5.        Since this program is really easy to understand, this doc consists
  6.        mainly of the program history.
  7.  
  8. ------ What's so special about GMC?
  9.  
  10. In fact, I don't know. It's just another MemClock to decorate your Workbench.
  11. I just wanted to gain some experience points in using C, so I started with
  12. something easy. Since version 1.02 turned out to be really useful I decided to
  13. continue the support for a while. Enjoy!
  14.  
  15. Note:  Due to the powerful combination of Delay and TaskPri I guess that this
  16.        utility - considered it is configured well - uses only a neglectable
  17.        amount of CPU time. Figure out yourselves!
  18.  
  19. Another note: If you specify a high Delay value, all events (like closing the
  20.               window and opening the prefs window) will take a while to
  21.               be processed. This is NOT a bug, it results from the fact that
  22.               Intuition doesn't spend too much time watching GMC.
  23.               (I know this is not too professional, but it works :-)
  24.  
  25. ------ Installing GMC
  26.  
  27. Just pull the GMC icon into your WBStartup drawer. You won't need to add
  28. "DONOTWAIT" since GMC is self-detaching.
  29. Note to 1.3 users: 1.3 is history! You won't regret an upgrade! (because you
  30. may then use GMC ;-)
  31.  
  32. ------ Features which are not necessarily clear at first look:
  33.  
  34. * Config
  35. GMC tries to save the config file to envarc: or, if envarc: isn't present,
  36. to s:. On startup both paths are searched for the file.
  37.  
  38. * Delay (preferences window)
  39. The time to wait between two display updates. if Delay is 0, the display will
  40. be updated continuously and thus steal you lots of CPU time! So set this value
  41. carefully. 5-50 is most reasonable.
  42. Intuition will check both menu and close gadget only at display update time,
  43. so don't worry about eventual delays before GMC obeyes your orders.
  44.  
  45. * AddWith (preferences window)
  46. This is interesting if you are using a proportional screen font. This value
  47. will always be added to the calculated window width.
  48.  
  49. * CmpV (preferences window)
  50. This one also should only be used in connection with a prop font.
  51. See program history for detailed explanation.
  52.  
  53. * Separate (preferences window)
  54. This is the character used to separate the display items.
  55.  
  56. ------ Copying GMC
  57.  
  58. GMC is FreeWare, that means you may do with it whatever you want, except
  59. modify it. If you copy it around, please leave its drawer (icons, docfile)
  60. together. Thank you.
  61.  
  62. ------ Known Bugs
  63.  
  64. - Sometimes, the size calculation seems to fail. I couldn't find the reason
  65.   for this phenomenon, because it appears REALLY seldom.
  66.  
  67. - Don't give a damn about what CPU monitors tell you about the time usage of
  68.   GMC. Just tear down the TaskPri value and GMC will release almost all of its
  69.   CPU time as soon as there is another task with a higher TaskPri.
  70.  
  71. - The timer routine I used continuously writes temporary data into the RAM
  72.   disk. I've tried hard to find a better one, but the Amiga documentation
  73.   seems to be kind of incomplete or, at least, difficult to survey.
  74.  
  75. ------ Program History:
  76.  
  77. v1.00: First version, never released.
  78.  
  79. v1.01: Added keyboard support in GUI.
  80.  
  81. v1.02: Fixed some minor bugs;
  82.        added taskpri slider to gain lots of CPU time;
  83.        first version I spread around.
  84.  
  85. v1.04: Improved proportional font handling: width of window will no longer be
  86.        different on every startup. This is achieved by saving the width with
  87.        the preferences and then comparing it to the recalculated width on
  88.        every startup. Only if the difference exceeds a certain tolerance level
  89.        the recalculated value will be used.
  90.  
  91. v1.05: Updated the preferences part to support that certain tolerance level
  92.        named above. It is called "CmpV" (Comparison Value). If you're using a
  93.        proportional font with a very varying character width (like "emerald")
  94.        you will need to raise CmpV and probably also AddWidth in order to
  95.        gain a window with proper size and a fixed placement.
  96.        (I hope the function of CmpV is now clear - it's difficult to explain.)
  97.  
  98. v1.06: Slight modifications: NewLook menu, minor improvements made in time
  99.        routine. Now GMC is self-detaching and therefore a bit longer - sorry.
  100.  
  101. ------ Compiled: 14-Aug-94
  102.        Doc updated (known bugs): 03-Dec-94
  103.